home *** CD-ROM | disk | FTP | other *** search
/ Aminet 30 / Aminet 30 (1999)(Schatztruhe)[!][Apr 1999].iso / Aminet / util / libs / PGPLib1_3.lha / PGP / doc / pgp.doc next >
Text File  |  1998-03-28  |  5KB  |  157 lines
  1. $Id: pgp.doc,v 1.7 1998/03/28 00:01:23 andre Exp andre $
  2.  
  3. TABLE OF CONTENTS
  4.  
  5. pgp.library/PGPEncrypt
  6. pgp.library/PGPDecrypt
  7. pgp.library/PGPFault
  8. pgp.library/PGPSign
  9. pgp.library/--tags--
  10. pgp.library/PGPEncrypt                                 pgp.library/PGPEncrypt
  11.  
  12.     NAME
  13.         PGPEncrypt -- Encrypt a file using pgp
  14.  
  15.     SYNOPSIS
  16.         error = PGPEncrypt (filename, userid, tags)
  17.           D0                   A0       A1     D0
  18.  
  19.         LONG PGPEncrypt (STRPTR, STRPTR, struct TagItem *)
  20.  
  21.         error = PGPEncryptTags (filename, userid, Tag1, ...)
  22.  
  23.         LONG PGPEncryptTags (STRPTR, STRPTR, ULONG, ...)
  24.         
  25.     FUNCTION
  26.         Encrypts a file using pgp. The first public key found for the
  27.         userid will be used.
  28.  
  29.     INPUTS
  30.         filename - name of the file to encrypt
  31.         userid   - id of the user
  32.         tags     - pointer to an array of tag items (permitted tags:
  33.                    PGP_Binary, PGP_ConOutput, PGP_OutFile, PGP_Password,
  34.                    PGP_Sign, PGP_UserId, see pgp.library/--tags--)
  35.  
  36.     RESULT
  37.         error    - 0 for success, result from pgp command, or -1
  38.  
  39.     NOTES
  40.         This function is only a capsulated call for the program "pgp".
  41.         That means the pgp package must be installed correctly.
  42. pgp.library/PGPDecrypt                                 pgp.library/PGPDecrypt
  43.  
  44.     NAME
  45.         PGPDecrypt -- Decrypt a file using pgp
  46.  
  47.     SYNOPSIS
  48.         error = PGPDecrypt (filename, password, tags)
  49.           D0                   A0        A1      D0
  50.  
  51.         LONG PGPDecrypt (STRPTR, STRPTR, struct TagItem *)
  52.  
  53.         error = PGPDecryptTags (filename, password, Tag1, ...)
  54.  
  55.         LONG PGPDecryptTags (STRPTR, STRPTR, ULONG, ...)
  56.         
  57.     FUNCTION
  58.         Decrypts a file using pgp.
  59.  
  60.     INPUTS
  61.         filename - name of the file to encrypt
  62.         password - pass phrase
  63.         tags     - pointer to an array of tag items (permitted tags:
  64.                    PGP_ConOutput, PGP_OutFile, see pgp.library/--tags--)
  65.  
  66.     RESULT
  67.         error    - 0 for success, result from pgp command, or -1
  68.  
  69.     NOTES
  70.         This function is only a capsulated call for the program "pgp".
  71.         That means the pgp package must be installed correctly.
  72. pgp.library/PGPFault                                     pgp.library/PGPFault
  73.  
  74.     NAME
  75.         PGPFault -- Returns the text associated with a PGP error code
  76.  
  77.     SYNOPSIS
  78.         len = PGPFault (code, header, buffer, len)
  79.         D0               D0    A0       A1    D1
  80.  
  81.         LONG PGPFault (LONG, STRPTR, STRPTR, LONG)
  82.  
  83.     FUNCTION
  84.         This routine obtains the error message text for the given error code.
  85.         The header is prepended to the text of the error message, followed
  86.         by a colon.  Puts a null-terminated string for the error message into
  87.         the buffer. If there is no message for the error code, the message
  88.         will be "Error <number>".
  89.  
  90.         The number of characters put into the buffer is returned, which will
  91.         be 0 if the code passed in was 0.
  92.  
  93.     INPUTS
  94.         code   - error code
  95.         header - header to output before error text
  96.         buffer - buffer to receive error message
  97.         len    - length of the buffer
  98.  
  99.     RESULT
  100.         len    - number of characters put into buffer (may be 0)
  101. pgp.library/PGPSign                                       pgp.library/PGPSign
  102.  
  103.     NAME
  104.         PGPSign -- Sign a file using pgp
  105.  
  106.     SYNOPSIS
  107.         error = PGPSign (filename, password, tags)
  108.           D0                A0        A1      D0
  109.  
  110.         LONG PGPSign (STRPTR, STRPTR, struct TagItem *)
  111.  
  112.         error = PGPSignTags (filename, password, Tag1, ...)
  113.  
  114.         LONG PGPSignTags (STRPTR, STRPTR, ULONG, ...)
  115.         
  116.     FUNCTION
  117.         Signs a file using pgp. If no user id is given, the first key on the
  118.         secret key ring will be used.
  119.  
  120.     INPUTS
  121.         filename - name of the file to encrypt
  122.         password - pass phrase
  123.         tags     - pointer to an array of tag items (permitted tags:
  124.                    PGP_Break, PGP_ConOutput, PGP_OutFile, PGP_UserId, see
  125.                    pgp.library/--tags--)
  126.  
  127.     RESULT
  128.         error    - 0 for success, result from pgp command, or -1
  129.  
  130.     NOTES
  131.         This function is only a capsulated call for the program "pgp".
  132.         That means the pgp package must be installed correctly.
  133. pgp.library/--tags--                                     pgp.library/--tags--
  134.  
  135.     PGP_Binary (BOOL)
  136.         specifies that you don't want to convert the output into printable
  137.         ASCII "radix-64" format
  138.  
  139.     PGP_Break (BOOL)
  140.         generate signature certificate that is detached from the text it
  141.         signs
  142.  
  143.     PGP_ConOutput (STRPTR)
  144.         optional file where to redirect the standard output from pgp
  145.  
  146.     PGP_OutFile (STRPTR)
  147.         optional file where to put processed output
  148.  
  149.     PGP_Password (STRPTR)
  150.         optional pass phrase for signing before encrypting
  151.  
  152.     PGP_Sign (BOOL)
  153.         sign the file before encrypting it
  154.  
  155.     PGP_UserId (STRPTR)
  156.         optional string to search for a matching secret key
  157.